iT邦幫忙

2024 iThome 鐵人賽

DAY 7
0

Swagger 是一套開源工具,主要用來幫助我們描述和設計 API。它基於 OpenAPI 規範(以前叫 Swagger 規範),能讓我們用簡單的方式定義 API 的行為。它會生成一份精美的 API 文件,供開發者和使用者參考。

Swagger UI 與 Swagger Editor

  • Swagger UI:
    這是一個非常酷的可視化工具,能直接從你的 API 文件生成互動式網頁介面!用戶可以透過這個介面來測試 API,而不用寫一行代碼。只要貼上 API 的 JSON 或 YAML 定義,Swagger UI 立馬給你一個直觀的操作界面。完全讓測試變得超簡單!

  • Swagger Editor:
    這個工具則是專門用來編輯 OpenAPI 文件的。你可以直接在線上使用它,寫下 YAML 或 JSON 格式的 OpenAPI 文件。當你寫好文件後,Swagger Editor 會即時顯示文件的效果,還能提示你語法錯誤喔!超方便!

Swagger 文件格式:OpenAPI 規範
Swagger 使用的文件格式是基於 OpenAPI 規範。這是一種用來描述 RESTful API 的標準格式,通常用 YAML 或 JSON 來編寫。OpenAPI 文件會描述 API 的端點、參數、請求與回應格式等內容。透過這個標準,你的 API 文件可以很輕鬆地和其他工具或平台整合。

OpenAPI 文件結構包含:

  • info:API 的基本資訊(名稱、版本、描述)
  • paths:每個 API 路徑(例如 /pets)
  • methods:每個路徑下支援的 HTTP 方法(GET、POST 等)
  • responses:每個方法回應的狀態碼與結構

上一篇
DAY6. Swagger初步認識
下一篇
DAY8. 如何使用 Swagger 編寫 API 文檔
系列文
API 101:從基礎認識到應用的全方位指南-Swagger/Postman30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言